/**
 * Software License, Version 1.0
 *
 * Copyright 2003 The Trustees of Indiana University.  All rights reserved.
 *
 *
 *Redistribution and use in source and binary forms, with or without
 *modification, are permitted provided that the following conditions are met:
 *
 *1) All redistributions of source code must retain the above copyright notice,
 * the list of authors in the original source code, this list of conditions and
 * the disclaimer listed in this license;
 *2) All redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the disclaimer listed in this license in
 * the documentation and/or other materials provided with the distribution;
 *3) Any documentation included with all redistributions must include the
 * following acknowledgement:
 *
 *"This product includes software developed by the Community Grids Lab. For
 * further information contact the Community Grids Lab at
 * http://communitygrids.iu.edu/."
 *
 * Alternatively, this acknowledgement may appear in the software itself, and
 * wherever such third-party acknowledgments normally appear.
 *
 *4) The name Indiana University or Community Grids Lab or NaradaBrokering,
 * shall not be used to endorse or promote products derived from this software
 * without prior written permission from Indiana University.  For written
 * permission, please contact the Advanced Research and Technology Institute
 * ("ARTI") at 351 West 10th Street, Indianapolis, Indiana 46202.
 *5) Products derived from this software may not be called NaradaBrokering,
 * nor may Indiana University or Community Grids Lab or NaradaBrokering appear
 * in their name, without prior written permission of ARTI.
 *
 *
 * Indiana University provides no reassurances that the source code provided
 * does not infringe the patent or any other intellectual property rights of
 * any other entity.  Indiana University disclaims any liability to any
 * recipient for claims brought by any other entity based on infringement of
 * intellectual property rights or otherwise.
 *
 *LICENSEE UNDERSTANDS THAT SOFTWARE IS PROVIDED "AS IS" FOR WHICH NO
 *WARRANTIES AS TO CAPABILITIES OR ACCURACY ARE MADE. INDIANA UNIVERSITY GIVES
 *NO WARRANTIES AND MAKES NO REPRESENTATION THAT SOFTWARE IS FREE OF
 *INFRINGEMENT OF THIRD PARTY PATENT, COPYRIGHT, OR OTHER PROPRIETARY RIGHTS.
 *INDIANA UNIVERSITY MAKES NO WARRANTIES THAT SOFTWARE IS FREE FROM "BUGS",
 *"VIRUSES", "TROJAN HORSES", "TRAP DOORS", "WORMS", OR OTHER HARMFUL CODE.
 *LICENSEE ASSUMES THE ENTIRE RISK AS TO THE PERFORMANCE OF SOFTWARE AND/OR
 *ASSOCIATED MATERIALS, AND TO THE PERFORMANCE AND VALIDITY OF INFORMATION
 *GENERATED USING SOFTWARE.
 */
package cgl.narada.wsinfra.deployment.axis.wsr.handler;

import java.util.StringTokenizer;

import javax.xml.namespace.QName;
import javax.xml.soap.SOAPMessage;

import org.apache.axis.MessageContext;
import org.apache.axis.client.Call;
import org.apache.axis.client.Service;
import org.apache.axis.message.SOAPEnvelope;

import cgl.narada.wsinfra.WsMessageFlow;
import cgl.narada.wsinfra.deployment.SOAPContextFactory;
import cgl.narada.wsinfra.deployment.axis.WsInfraAxisHandler;
import cgl.narada.wsinfra.deployment.axis.wsr.WsrServicesFactory;
import cgl.narada.wsinfra.exception.DeploymentException;
import cgl.narada.wsinfra.exception.IncorrectExchangeException;
import cgl.narada.wsinfra.exception.MessageFlowException;
import cgl.narada.wsinfra.exception.ParsingException;
import cgl.narada.wsinfra.exception.ProcessingException;
import cgl.narada.wsinfra.exception.UnknownExchangeException;
import cgl.narada.wsinfra.schemas.addressing.ActionDocument;
import cgl.narada.wsinfra.schemas.addressing.EndpointReferenceType;
import cgl.narada.wsinfra.schemas.addressing.FromDocument;
import cgl.narada.wsinfra.schemas.addressing.ToDocument;
import cgl.narada.wsinfra.schemas.soap.EnvelopeDocument;
import cgl.narada.wsinfra.util.SoapEnvelopeConversion;
import cgl.narada.wsinfra.util.SoapMessageAlteration;
import cgl.narada.wsinfra.wsa.AddressingHeaders;
import cgl.narada.wsinfra.wsa.ParseWsaHeaders;
import cgl.narada.wsinfra.wsa.WsaEprCreator;
import cgl.narada.wsinfra.wsa.WsaProcessingFactory;
import cgl.narada.wsinfra.wsr.WsrNodeUtils;
import cgl.narada.wsinfra.wsr.WsrProcessingFactory;
import cgl.narada.wsinfra.wsr.WsrSinkGroupMonitor;
import cgl.narada.wsinfra.wsr.WsrSinkGroupMonitorFactory;
import cgl.narada.wsinfra.wsr.impl.WsrSinkNode;
import cgl.narada.wsinfra.wsr.storage.WsrStorageException;

/**
 * @author Damodar Yemme
 * $Date: 2005/04/27 20:37:43 $
 * $Revision: 1.6 $
 *
 *  This handler class will help Sink web services to create call to Source
 * after processing SOAPMessage by Wsr Sink Node
 */
public class WsrSinkHandler extends WsInfraAxisHandler {
    private SOAPContextFactory soapContextFactory;

    private WsrNodeUtils wsrNodeUtils;

    private ParseWsaHeaders parseWsaHeaders;

    private AddressingHeaders addressingHeaders;

    private String moduleName = "WsrSinkHandler :";

    private String sourceAddress;

    private String sinkAddress;

    private String targetServiceAddress;

    private WsaEprCreator eprCreator;

    private WsrSinkNode wsrSinkProcessor;

    private EndpointReferenceType sinkEpr, sourceEpr, targetServiceEpr;

    private String handlerClassNames;

    private String methodName;

    /**
     * Constructor for the Sink handler and It will initiates all required
     * services for Wsr Hanlder to process SOAPMessage.
     *
     * @throws DeploymentException
     */
    public WsrSinkHandler() throws DeploymentException {
        sourceAddress = WsrServicesFactory.getSourceAddress();
        sinkAddress = WsrServicesFactory.getSinkAddress();
        targetServiceAddress = WsrServicesFactory.getTargetServiceAddress();
        eprCreator = WsaProcessingFactory.getWsaEprCreator();
        sourceEpr = eprCreator.createEpr(sourceAddress);
        sinkEpr = eprCreator.createEpr(sinkAddress);
        targetServiceEpr = eprCreator.createEpr(targetServiceAddress);
        String configFile = WsrServicesFactory.getSinkNodeConfigFile();
        wsrSinkProcessor = new WsrSinkNode(configFile);
        wsrSinkProcessor.setMessageFlow(this);
        wsrSinkProcessor.setEndpointReference(sinkEpr);
        wsrNodeUtils = WsrProcessingFactory.getWsrNodeUtils();
        handlerClassNames = WsrServicesFactory.getHandlerChain();
        methodName = WsrServicesFactory.getMethodName();

        setIdentifier(moduleName);
        this.setSoapActionURI(methodName);
        this.initilizeInfraAxisHandler();
        addResponseHandlerChain(handlerClassNames);
        // Initialize the Monitor
	try {
            WsrSinkGroupMonitorFactory wsrSinkGroupMonitorFactory = 
            	WsrProcessingFactory.getWsrSinkGroupMonitorFactory();
            WsrSinkGroupMonitor wsrSinkGroupMonitor = wsrSinkGroupMonitorFactory
                    .getWsrSinkGroupMonitor(configFile, this);
            wsrSinkGroupMonitor.startServices();
        } catch (WsrStorageException wsrStorageEx) {
            throw new DeploymentException(moduleName + wsrStorageEx.toString());
	    }

    }

    /**
     * This method will add Response handler chain
     *
     * @param classNames
     */
    private void addResponseHandlerChain(String classNames) {

        StringTokenizer classNameTokenizer = new StringTokenizer(classNames,
                ",");

        while (classNameTokenizer.hasMoreTokens()) {

            String className = classNameTokenizer.nextToken();
            org.apache.axis.handlers.BasicHandler handler
            = (org.apache.axis.handlers.BasicHandler) createObject(className);
            this.addHandler(handler);
        }
    }

    /**
     * This method creates response handler chain class instance.
     *
     * @param classNames
     */
    private Object createObject(String className) {
        Object object = null;
        try {
            Class classDefinition = Class.forName(className);
            object = classDefinition.newInstance();
        } catch (Exception e) {
            System.out.println("Getting error: "+ moduleName +"\n\n");
	     e.printStackTrace();
        }

        return object;
    }

    /**
     * This method will be the one all implementation classes has to overwrite.
     * This will executed by AXIS Engine.
     * @param messageContext
     */
    public void invoke(MessageContext messageContext) {
        try {

            SOAPMessage soapMessage = (SOAPMessage) messageContext
                    .getCurrentMessage();
            SoapEnvelopeConversion soapEnvelopeConversion
						= SoapEnvelopeConversion.getInstance();
            EnvelopeDocument envelopeDocument = soapEnvelopeConversion
                    .getEnvelopeDocument(soapMessage);

	    QName qName = new QName("http://docs.oasis-open.org/wss/2004/01/oasis-"+
	    		"200401-wss-wssecurity-secext-1.0.xsd","Security");      
      SoapMessageAlteration soapMessageAlteration = 
    	  									SoapMessageAlteration.getInstance();
      soapMessageAlteration.removeFromSoapHeader(envelopeDocument,qName); 	

            String from = null;
            String to = null;
            ToDocument toDocument = null;
            FromDocument fromDocument = null;
            AddressingHeaders addressingHeaders = null;
            ParseWsaHeaders parseWsaHeaders = WsaProcessingFactory
                    .getParseWsaHeaders();

            try {
                toDocument = parseWsaHeaders.getTo(envelopeDocument);
                fromDocument = parseWsaHeaders.getFrom(envelopeDocument);
                addressingHeaders = parseWsaHeaders
                        .getAddressingHeaders(envelopeDocument);
            } catch (ParsingException parseEx) {
                // Ignore this exception.
          System.out.println("Problems parsing the envelope"+moduleName+"\n\n");
		parseEx.printStackTrace();
            }
            String action = null;
            ActionDocument actionDocument = null;
            try {
                actionDocument = addressingHeaders.getAction();
                if (actionDocument == null) {
                    String reason = moduleName
                            + "Action missing. Processor only deals with "
                            + "WS-Eventing exchanges.";
                }

                if (actionDocument != null) {
                    action = actionDocument.getAction().getStringValue();
                }
            } catch (Exception e) {
                System.out.println(moduleName
                        + "Exception in Processing action\n\n ");
		 e.printStackTrace();
            }

            if (toDocument == null) {
                to = "";
            } else {
                to = toDocument.getTo().getStringValue();

            }

            if(!to.equalsIgnoreCase(WsrServicesFactory.getSourceAddress()))
            	processMessage(envelopeDocument,WsMessageFlow.FROM_APPLICATION);
            else {
            	boolean isProcessed = processMessage(envelopeDocument, 
            								WsMessageFlow.FROM_NETWORK);
            }

        } catch (UnknownExchangeException ex) {
            System.out
                    .println(moduleName + " UnknownExchangeException : " + ex);
        } catch (IncorrectExchangeException ex) {
            System.out.println(moduleName + " IncorrectExchangeException : "
                    + ex);
        } catch (MessageFlowException ex) {
            System.out.println(moduleName + " MessageFlowException : " + ex);
        } catch (Exception ex) {
            System.out.println(moduleName + " Exception in processMessage() "
                    + ex);
        }
    }

    /**
     * This method returns a boolean which indicates whether further processing
     * should continue or if it should stop. A return value of <i>true </i>
     * indicates that processing should continue; while <i>false </i> indicates
     * that processing should stop.
     */
    public boolean processMessage(EnvelopeDocument envelopeDocument,
            int direction) throws UnknownExchangeException,
            IncorrectExchangeException, MessageFlowException,
            ProcessingException {
        String from = "the APPLICATION.";
        if (direction == WsMessageFlow.FROM_NETWORK) {
            from = "the Network.";
        }
	 boolean continueOperations = wsrSinkProcessor.processExchange(
                envelopeDocument, direction);
	System.out.println("************ Message by Sink Handler ************\n\n"+
												envelopeDocument.toString());
        return continueOperations;

    }

    public final void enrouteToApplication(SOAPMessage soapMessage)
            throws MessageFlowException {
        try {
            org.apache.axis.message.SOAPEnvelope senv
						= (org.apache.axis.message.SOAPEnvelope) soapMessage
                    .getSOAPPart().getEnvelope();
            Service service = new Service();
            Call call = (Call) service.createCall();
            call.setTargetEndpointAddress(targetServiceAddress);
            call.setSOAPActionURI(methodName);
            SOAPEnvelope env = (SOAPEnvelope) call.invoke(senv);
        } catch (Exception e) {
           // System.out.println(moduleName + " Exception here\n\n " );
	    // e.printStackTrace();
        }
    }
}
